<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Services_Zencoder_Jobs</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Services_Zencoder_Jobs</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-vars">Vars</a>
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Zencoder API client interface.</p>
	<ul class="tags">
				<li><span class="field">author:</span> Michael Christopher &lt;<a href="mailto:m@zencoder.com">m@zencoder.com</a>&gt;</li>
				<li><span class="field">version:</span> Release: 2.0.2</li>
				<li><span class="field">link:</span> <a href="http://github.com/zencoder/zencoder-php">http://github.com/zencoder/zencoder-php</a></li>
				<li><span class="field">license:</span> <a href="http://creativecommons.org/licenses/MIT/MIT">http://creativecommons.org/licenses/MIT/MIT</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Zencoder---Jobs.php.html">/Zencoder/Jobs.php</a> (line <span class="field">13</span>)
		</p>
		
				
		<pre><a href="../Services_Zencoder/Services_Zencoder_Base.html">Services_Zencoder_Base</a>
   |
   --Services_Zencoder_Jobs</pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-vars">Vars</a>
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																				
												<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#cancel" title="details" class="method-name">cancel</a>
											(<span class="var-type">integer</span>&nbsp;<span class="var-name">$job_id</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../Services_Zencoder/Services_Zencoder_Job.html">Services_Zencoder_Job</a></span>
										<a href="#create" title="details" class="method-name">create</a>
											([<span class="var-type">array</span>&nbsp;<span class="var-name">$job</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../Services_Zencoder/Services_Zencoder_Job.html">Services_Zencoder_Job</a></span>
										<a href="#details" title="details" class="method-name">details</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$job_id</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>], <span class="var-type">integer</span>&nbsp;<span class="var-name">$input_id</span>)
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../Services_Zencoder/Services_Zencoder_Job.html">Services_Zencoder_Job</a></span>
										<a href="#index" title="details" class="method-name">index</a>
											([<span class="var-type">array</span>&nbsp;<span class="var-name">$args</span> = <span class="var-default">array()</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../Services_Zencoder/Services_Zencoder_Progress.html">Services_Zencoder_Progress</a></span>
										<a href="#progress" title="details" class="method-name">progress</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$job_id</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>], <span class="var-type">integer</span>&nbsp;<span class="var-name">$input_id</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#resubmit" title="details" class="method-name">resubmit</a>
											(<span class="var-type">integer</span>&nbsp;<span class="var-name">$job_id</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
										<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../Services_Zencoder/Services_Zencoder_Base.html">Services_Zencoder_Base</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../Services_Zencoder/Services_Zencoder_Base.html#var$proxy">Services_Zencoder_Base::$proxy</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-vars">Vars</a>
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodcancel" id="cancel"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">cancel</span> (line <span class="line-number">95</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Cancel a job</p>
	<ul class="tags">
				<li><span class="field">return:</span> If the operation was successful</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			cancel
		</span>
					(<span class="var-type">integer</span>&nbsp;<span class="var-name">$job_id</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$job_id</span><span class="var-description">: ID of the job you want to cancel</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$params</span><span class="var-description">: Optional overrides</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcreate" id="create"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">create</span> (line <span class="line-number">23</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Create a new job</p>
	<ul class="tags">
				<li><span class="field">return:</span> The object representation of the resource</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../Services_Zencoder/Services_Zencoder_Job.html">Services_Zencoder_Job</a></span>
		<span class="method-name">
			create
		</span>
					([<span class="var-type">array</span>&nbsp;<span class="var-name">$job</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$job</span><span class="var-description">: Array of attributes to use when creating the job</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$params</span><span class="var-description">: Optional overrides</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddetails" id="details"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">details</span> (line <span class="line-number">59</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return details of a specific job</p>
	<ul class="tags">
				<li><span class="field">return:</span> The object representation of the resource</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../Services_Zencoder/Services_Zencoder_Job.html">Services_Zencoder_Job</a></span>
		<span class="method-name">
			details
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$job_id</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>], <span class="var-type">integer</span>&nbsp;<span class="var-name">$input_id</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$input_id</span><span class="var-description">: ID of the input file you want details for</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$params</span><span class="var-description">: Optional overrides</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$job_id</span>			</li>
				</ul>
		
			
	</div>
<a name="methodindex" id="index"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">index</span> (line <span class="line-number">47</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">List all jobs on your account</p>
	<ul class="tags">
				<li><span class="field">return:</span> The object representation of the resource</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../Services_Zencoder/Services_Zencoder_Job.html">Services_Zencoder_Job</a></span>
		<span class="method-name">
			index
		</span>
					([<span class="var-type">array</span>&nbsp;<span class="var-name">$args</span> = <span class="var-default">array()</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$args</span><span class="var-description">: Array of filters to use when loading index</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$params</span><span class="var-description">: Optional overrides</span>			</li>
				</ul>
		
			
	</div>
<a name="methodprogress" id="progress"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">progress</span> (line <span class="line-number">71</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return progress of a specific job</p>
	<ul class="tags">
				<li><span class="field">return:</span> The object representation of the resource</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../Services_Zencoder/Services_Zencoder_Progress.html">Services_Zencoder_Progress</a></span>
		<span class="method-name">
			progress
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$job_id</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>], <span class="var-type">integer</span>&nbsp;<span class="var-name">$input_id</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$input_id</span><span class="var-description">: ID of the input file you want progress for</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$params</span><span class="var-description">: Optional overrides</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$job_id</span>			</li>
				</ul>
		
			
	</div>
<a name="methodresubmit" id="resubmit"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">resubmit</span> (line <span class="line-number">83</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Resubmit a job</p>
	<ul class="tags">
				<li><span class="field">return:</span> If the operation was successful</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			resubmit
		</span>
					(<span class="var-type">integer</span>&nbsp;<span class="var-name">$job_id</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$job_id</span><span class="var-description">: ID of the job you want to resubmit</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$params</span><span class="var-description">: Optional overrides</span>			</li>
				</ul>
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../Services_Zencoder/Services_Zencoder_Base.html">Services_Zencoder_Base</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../Services_Zencoder/Services_Zencoder_Base.html#method__construct">Services_Zencoder_Base::__construct()</a></span><br>
													<span class="method-name"><a href="../Services_Zencoder/Services_Zencoder_Base.html#methodcreateData">Services_Zencoder_Base::createData()</a></span><br>
													<span class="method-name"><a href="../Services_Zencoder/Services_Zencoder_Base.html#methoddeleteData">Services_Zencoder_Base::deleteData()</a></span><br>
													<span class="method-name"><a href="../Services_Zencoder/Services_Zencoder_Base.html#methodretrieveData">Services_Zencoder_Base::retrieveData()</a></span><br>
													<span class="method-name"><a href="../Services_Zencoder/Services_Zencoder_Base.html#methodupdateData">Services_Zencoder_Base::updateData()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Wed, 11 Jan 2012 14:56:54 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
	</p>
	</div></body>
</html>